<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>Streams xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/commons/fileupload/util/Streams.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> * the License.  You may obtain a copy of the License at</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> *</em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> *</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> * limitations under the License.</em>
<a name="16" href="#16">16</a>  <em class="jxr_comment"> */</em>
<a name="17" href="#17">17</a>  <strong class="jxr_keyword">package</strong> org.apache.commons.fileupload.util;
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> java.io.ByteArrayOutputStream;
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.io.IOException;
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> java.io.InputStream;
<a name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> java.io.OutputStream;
<a name="23" href="#23">23</a>  
<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.fileupload.InvalidFileNameException;
<a name="25" href="#25">25</a>  
<a name="26" href="#26">26</a>  
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Utility class for working with streams.</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> */</em>
<a name="29" href="#29">29</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/commons/fileupload/util/Streams.html">Streams</a> {
<a name="30" href="#30">30</a>      <em class="jxr_javadoccomment">/**</em>
<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment">     * Private constructor, to prevent instantiation.</em>
<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment">     * This class has only static methods.</em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment">     */</em>
<a name="34" href="#34">34</a>      <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/commons/fileupload/util/Streams.html">Streams</a>() {
<a name="35" href="#35">35</a>          <em class="jxr_comment">// Does nothing</em>
<a name="36" href="#36">36</a>      }
<a name="37" href="#37">37</a>  
<a name="38" href="#38">38</a>      <em class="jxr_javadoccomment">/**</em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment">     * Default buffer size for use in</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment">     * {@link #copy(InputStream, OutputStream, boolean)}.</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment">     */</em>
<a name="42" href="#42">42</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_BUFFER_SIZE = 8192;
<a name="43" href="#43">43</a>  
<a name="44" href="#44">44</a>      <em class="jxr_javadoccomment">/**</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment">     * Copies the contents of the given {@link InputStream}</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment">     * to the given {@link OutputStream}. Shortcut for</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment">     *   copy(pInputStream, pOutputStream, new byte[8192]);</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment">     * @param pInputStream The input stream, which is being read.</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment">     * It is guaranteed, that {@link InputStream#close()} is called</em>
<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment">     * on the stream.</em>
<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment">     * @param pOutputStream The output stream, to which data should</em>
<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment">     * be written. May be null, in which case the input streams</em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment">     * contents are simply discarded.</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     * @param pClose True guarantees, that {@link OutputStream#close()}</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     * is called on the stream. False indicates, that only</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment">     * {@link OutputStream#flush()} should be called finally.</em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment">     *</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment">     * @return Number of bytes, which have been copied.</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment">     * @throws IOException An I/O error occurred.</em>
<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment">     */</em>
<a name="63" href="#63">63</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">long</strong> copy(InputStream pInputStream,
<a name="64" href="#64">64</a>              OutputStream pOutputStream, <strong class="jxr_keyword">boolean</strong> pClose)
<a name="65" href="#65">65</a>              <strong class="jxr_keyword">throws</strong> IOException {
<a name="66" href="#66">66</a>          <strong class="jxr_keyword">return</strong> copy(pInputStream, pOutputStream, pClose,
<a name="67" href="#67">67</a>                  <strong class="jxr_keyword">new</strong> byte[DEFAULT_BUFFER_SIZE]);
<a name="68" href="#68">68</a>      }
<a name="69" href="#69">69</a>  
<a name="70" href="#70">70</a>      <em class="jxr_javadoccomment">/**</em>
<a name="71" href="#71">71</a>  <em class="jxr_javadoccomment">     * Copies the contents of the given {@link InputStream}</em>
<a name="72" href="#72">72</a>  <em class="jxr_javadoccomment">     * to the given {@link OutputStream}.</em>
<a name="73" href="#73">73</a>  <em class="jxr_javadoccomment">     * @param pIn The input stream, which is being read.</em>
<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">     *   It is guaranteed, that {@link InputStream#close()} is called</em>
<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">     *   on the stream.</em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">     * @param pOut The output stream, to which data should</em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">     *   be written. May be null, in which case the input streams</em>
<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">     *   contents are simply discarded.</em>
<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">     * @param pClose True guarantees, that {@link OutputStream#close()}</em>
<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">     *   is called on the stream. False indicates, that only</em>
<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">     *   {@link OutputStream#flush()} should be called finally.</em>
<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     * @param pBuffer Temporary buffer, which is to be used for</em>
<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">     *   copying data.</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">     * @return Number of bytes, which have been copied.</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     * @throws IOException An I/O error occurred.</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     */</em>
<a name="87" href="#87">87</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">long</strong> copy(InputStream pIn,
<a name="88" href="#88">88</a>              OutputStream pOut, <strong class="jxr_keyword">boolean</strong> pClose,
<a name="89" href="#89">89</a>              byte[] pBuffer)
<a name="90" href="#90">90</a>      <strong class="jxr_keyword">throws</strong> IOException {
<a name="91" href="#91">91</a>          OutputStream out = pOut;
<a name="92" href="#92">92</a>          InputStream in = pIn;
<a name="93" href="#93">93</a>          <strong class="jxr_keyword">try</strong> {
<a name="94" href="#94">94</a>              <strong class="jxr_keyword">long</strong> total = 0;
<a name="95" href="#95">95</a>              <strong class="jxr_keyword">for</strong> (;;) {
<a name="96" href="#96">96</a>                  <strong class="jxr_keyword">int</strong> res = in.read(pBuffer);
<a name="97" href="#97">97</a>                  <strong class="jxr_keyword">if</strong> (res == -1) {
<a name="98" href="#98">98</a>                      <strong class="jxr_keyword">break</strong>;
<a name="99" href="#99">99</a>                  }
<a name="100" href="#100">100</a>                 <strong class="jxr_keyword">if</strong> (res &gt; 0) {
<a name="101" href="#101">101</a>                     total += res;
<a name="102" href="#102">102</a>                     <strong class="jxr_keyword">if</strong> (out != <strong class="jxr_keyword">null</strong>) {
<a name="103" href="#103">103</a>                         out.write(pBuffer, 0, res);
<a name="104" href="#104">104</a>                     }
<a name="105" href="#105">105</a>                 }
<a name="106" href="#106">106</a>             }
<a name="107" href="#107">107</a>             <strong class="jxr_keyword">if</strong> (out != <strong class="jxr_keyword">null</strong>) {
<a name="108" href="#108">108</a>                 <strong class="jxr_keyword">if</strong> (pClose) {
<a name="109" href="#109">109</a>                     out.close();
<a name="110" href="#110">110</a>                 } <strong class="jxr_keyword">else</strong> {
<a name="111" href="#111">111</a>                     out.flush();
<a name="112" href="#112">112</a>                 }
<a name="113" href="#113">113</a>                 out = <strong class="jxr_keyword">null</strong>;
<a name="114" href="#114">114</a>             }
<a name="115" href="#115">115</a>             in.close();
<a name="116" href="#116">116</a>             in = <strong class="jxr_keyword">null</strong>;
<a name="117" href="#117">117</a>             <strong class="jxr_keyword">return</strong> total;
<a name="118" href="#118">118</a>         } <strong class="jxr_keyword">finally</strong> {
<a name="119" href="#119">119</a>             <strong class="jxr_keyword">if</strong> (in != <strong class="jxr_keyword">null</strong>) {
<a name="120" href="#120">120</a>                 <strong class="jxr_keyword">try</strong> {
<a name="121" href="#121">121</a>                     in.close();
<a name="122" href="#122">122</a>                 } <strong class="jxr_keyword">catch</strong> (Throwable t) {
<a name="123" href="#123">123</a>                     <em class="jxr_comment">/*<em class="jxr_comment"> Ignore me */</em></em>
<a name="124" href="#124">124</a>                 }
<a name="125" href="#125">125</a>             }
<a name="126" href="#126">126</a>             <strong class="jxr_keyword">if</strong> (pClose  &amp;&amp;  out != <strong class="jxr_keyword">null</strong>) {
<a name="127" href="#127">127</a>                 <strong class="jxr_keyword">try</strong> {
<a name="128" href="#128">128</a>                     out.close();
<a name="129" href="#129">129</a>                 } <strong class="jxr_keyword">catch</strong> (Throwable t) {
<a name="130" href="#130">130</a>                     <em class="jxr_comment">/*<em class="jxr_comment"> Ignore me */</em></em>
<a name="131" href="#131">131</a>                 }
<a name="132" href="#132">132</a>             }
<a name="133" href="#133">133</a>         }
<a name="134" href="#134">134</a>     }
<a name="135" href="#135">135</a> 
<a name="136" href="#136">136</a>     <em class="jxr_javadoccomment">/**</em>
<a name="137" href="#137">137</a> <em class="jxr_javadoccomment">     * This convenience method allows to read a</em>
<a name="138" href="#138">138</a> <em class="jxr_javadoccomment">     * {@link org.apache.commons.fileupload.FileItemStream}'s</em>
<a name="139" href="#139">139</a> <em class="jxr_javadoccomment">     * content into a string. The platform's default character encoding</em>
<a name="140" href="#140">140</a> <em class="jxr_javadoccomment">     * is used for converting bytes into characters.</em>
<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">     * @param pStream The input stream to read.</em>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">     * @see #asString(InputStream, String)</em>
<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">     * @return The streams contents, as a string.</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment">     * @throws IOException An I/O error occurred.</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">     */</em>
<a name="146" href="#146">146</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String asString(InputStream pStream) <strong class="jxr_keyword">throws</strong> IOException {
<a name="147" href="#147">147</a>         ByteArrayOutputStream baos = <strong class="jxr_keyword">new</strong> ByteArrayOutputStream();
<a name="148" href="#148">148</a>         copy(pStream, baos, <strong class="jxr_keyword">true</strong>);
<a name="149" href="#149">149</a>         <strong class="jxr_keyword">return</strong> baos.toString();
<a name="150" href="#150">150</a>     }
<a name="151" href="#151">151</a> 
<a name="152" href="#152">152</a>     <em class="jxr_javadoccomment">/**</em>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment">     * This convenience method allows to read a</em>
<a name="154" href="#154">154</a> <em class="jxr_javadoccomment">     * {@link org.apache.commons.fileupload.FileItemStream}'s</em>
<a name="155" href="#155">155</a> <em class="jxr_javadoccomment">     * content into a string, using the given character encoding.</em>
<a name="156" href="#156">156</a> <em class="jxr_javadoccomment">     * @param pStream The input stream to read.</em>
<a name="157" href="#157">157</a> <em class="jxr_javadoccomment">     * @param pEncoding The character encoding, typically "UTF-8".</em>
<a name="158" href="#158">158</a> <em class="jxr_javadoccomment">     * @see #asString(InputStream)</em>
<a name="159" href="#159">159</a> <em class="jxr_javadoccomment">     * @return The streams contents, as a string.</em>
<a name="160" href="#160">160</a> <em class="jxr_javadoccomment">     * @throws IOException An I/O error occurred.</em>
<a name="161" href="#161">161</a> <em class="jxr_javadoccomment">     */</em>
<a name="162" href="#162">162</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String asString(InputStream pStream, String pEncoding)
<a name="163" href="#163">163</a>             <strong class="jxr_keyword">throws</strong> IOException {
<a name="164" href="#164">164</a>         ByteArrayOutputStream baos = <strong class="jxr_keyword">new</strong> ByteArrayOutputStream();
<a name="165" href="#165">165</a>         copy(pStream, baos, <strong class="jxr_keyword">true</strong>);
<a name="166" href="#166">166</a>         <strong class="jxr_keyword">return</strong> baos.toString(pEncoding);
<a name="167" href="#167">167</a>     }
<a name="168" href="#168">168</a> 
<a name="169" href="#169">169</a>     <em class="jxr_javadoccomment">/**</em>
<a name="170" href="#170">170</a> <em class="jxr_javadoccomment">     * Checks, whether the given file name is valid in the sense,</em>
<a name="171" href="#171">171</a> <em class="jxr_javadoccomment">     * that it doesn't contain any NUL characters. If the file name</em>
<a name="172" href="#172">172</a> <em class="jxr_javadoccomment">     * is valid, it will be returned without any modifications. Otherwise,</em>
<a name="173" href="#173">173</a> <em class="jxr_javadoccomment">     * an {@link InvalidFileNameException} is raised.</em>
<a name="174" href="#174">174</a> <em class="jxr_javadoccomment">     * @param pFileName The file name to check</em>
<a name="175" href="#175">175</a> <em class="jxr_javadoccomment">     * @return Unmodified file name, if valid.</em>
<a name="176" href="#176">176</a> <em class="jxr_javadoccomment">     * @throws InvalidFileNameException The file name was found to be invalid.</em>
<a name="177" href="#177">177</a> <em class="jxr_javadoccomment">     */</em>
<a name="178" href="#178">178</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String checkFileName(String pFileName) {
<a name="179" href="#179">179</a>         <strong class="jxr_keyword">if</strong> (pFileName != <strong class="jxr_keyword">null</strong>  &amp;&amp;  pFileName.indexOf('\u0000') != -1) {
<a name="180" href="#180">180</a>             <em class="jxr_comment">// pFileName.replace("\u0000", "&#92;&#92;0")</em>
<a name="181" href="#181">181</a>             <strong class="jxr_keyword">final</strong> StringBuffer sb = <strong class="jxr_keyword">new</strong> StringBuffer();
<a name="182" href="#182">182</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0;  i &lt; pFileName.length();  i++) {
<a name="183" href="#183">183</a>                 <strong class="jxr_keyword">char</strong> c = pFileName.charAt(i);
<a name="184" href="#184">184</a>                 <strong class="jxr_keyword">switch</strong> (c) {
<a name="185" href="#185">185</a>                     <strong class="jxr_keyword">case</strong> 0:
<a name="186" href="#186">186</a>                         sb.append(<span class="jxr_string">"&#92;&#92;0"</span>);
<a name="187" href="#187">187</a>                         <strong class="jxr_keyword">break</strong>;
<a name="188" href="#188">188</a>                     <strong class="jxr_keyword">default</strong>:
<a name="189" href="#189">189</a>                         sb.append(c);
<a name="190" href="#190">190</a>                         <strong class="jxr_keyword">break</strong>;
<a name="191" href="#191">191</a>                 }
<a name="192" href="#192">192</a>             }
<a name="193" href="#193">193</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/fileupload/InvalidFileNameException.html">InvalidFileNameException</a>(pFileName,
<a name="194" href="#194">194</a>                     <span class="jxr_string">"Invalid file name: "</span> + sb);
<a name="195" href="#195">195</a>         }
<a name="196" href="#196">196</a>         <strong class="jxr_keyword">return</strong> pFileName;
<a name="197" href="#197">197</a>     }
<a name="198" href="#198">198</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

